-
Notifications
You must be signed in to change notification settings - Fork 244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Prioritize errors in response #4728
base: dev
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
CI performance tests
|
I'd be interested in talking about this with the client teams a bit to get a full understanding. I feel like if we had to update all our snapshots then all users are also going to have to update their snapshots which could just raise eyebrows and require scrutiny. Some existing clients could also be making parsing assumptions about where items in the data structures will appear in the streams. As I recall, the entire original motivation for the spec recommendation (and bringing it to the working group) was to make it so that errors appeared at the top of the "Human User interface showing JSON" which defaults to being scrolled to the top of the frame. I can appreciate this convenience. However, it wasn't considered how this would impact users who are running terminal commands where the errors would no longer be at the bottom (that is at the bottom of the, for example, curl command output). Combined with the potential impacts I mentioned above, how about we talk next week with some folks and figure out where this fits? For example, maybe content type negotiation is the place to have our eyes. Wdyt? |
resolves #4375 Previously, the router would always respond with data first, and then show any errors in the request. The GraphQL spec suggests having the errors show up before data, so this commit makes errors output first before data.
9ee4a93
to
f84c0aa
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
Description here
Previously, the router would always respond with data first, and then show any errors in the request. The GraphQL spec suggests having the errors show up before data, so this commit makes errors output first before data.
As expected, this change updates a LOT of snapshot tests to move the errors up. Care was taken to make sure that the only change was the order of the output, but please double check during review.
Fixes #4375
Checklist
Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.
Exceptions
Note any exceptions here
Notes
Footnotes
It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩